/*
 * Copyright (C) 2010 Fores Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package jp.fores.midori.server.plugin.impl;

import java.io.Serializable;

import jp.fores.midori.core.dto.RPCInputDto;
import jp.fores.midori.core.dto.RPCOutputDto;
import jp.fores.midori.core.util.MidoriSerializationUtils;
import jp.fores.midori.server.WebContext;
import jp.fores.midori.server.exception.RPCIllegalRequestException;
import jp.fores.midori.server.plugin.AbstractRPCPlugin;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Javaのシリアライズ形式のリクエスト・レスポンスの処理を行うプラグインクラス。<br>
 */
public class JavaSerializePlugin extends AbstractRPCPlugin {
	//==========================================================
	//定数

	/**
	 * ログ出力用
	 */
	private static final Log log = LogFactory.getLog(JavaSerializePlugin.class);

	/**
	 * Content-Type
	 */
	//(この値は何かの仕様で定義されているわけではなく、適当な値です)
	public static final String CONTENT_TYPE = "binary/java-serialize";


	//==========================================================
	//メソッド

	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//抽象メソッドの実装

	/**
	 * {@inheritDoc}
	 */
	@Override
	public RPCInputDto requestToInputDto(WebContext context)
			throws RPCIllegalRequestException, Exception {
		//リクエストの入力ストリームをデシリアライズした結果のオブジェクトを、リモートプロシージャーコールの入力データを格納するためのDTOにキャストして返す
		return (RPCInputDto) MidoriSerializationUtils.deserialize(context.request.getInputStream());
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void outputDtoToResponse(RPCOutputDto outputDto, WebContext context)
			throws Exception {
		//レスポンスのContent-Typeに定数の値を設定する
		context.response.setContentType(CONTENT_TYPE);

		//出力データ用のDTOをシリアライズして、レスポンスの出力ストリームに直接書き込む
		MidoriSerializationUtils.serialize(outputDto, context.response.getOutputStream());
	}


	//_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
	//オーバーライドするメソッド

	/**
	 * サービスクラスのRPC用のメソッドを呼び出した後に処理を行いたい場合の、フックポイントとなるメソッドです。<br>
	 * このクラスでは、戻り値の型チェックを行います。<br>
	 *
	 * @param inputDto RPCの入力データを格納するためのDTOクラスのインスタンス
	 * @param outputDto RPCの出力データを格納するためのDTOクラスのインスタンス
	 * @throws Exception 例外
	 */
	@Override
	protected void executeAfterServiceCall(RPCInputDto inputDto,
			RPCOutputDto outputDto) throws Exception {
		//出力データがnullでなく、かつSerializableでない場合
		if ((outputDto.data != null)
				&& !(outputDto.data instanceof Serializable)) {
			//ClassCastExceptionを投げる
			throw new ClassCastException("Javaのシリアライズ形式用のプラグインでは、戻り値の型がSerializableではないメソッドは扱えません。");
		}
	}

}
